widgets.brease.VideoPlayer

Widget Description

short: Video/audio player widget
de: Zeigt einen Film und erlaubt dem Benutzer eine Interaktion mit dem Player
en: Plays video files, allowing user interaction with the player

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
autoplay Enables the autoplay functionality, that the video starts as soon as the widget is ready. Behavior Boolean false false false false false false true
controls If this attribute is true, VideoPlayer will offer controls to allow the user to control video playback, including volume, seeking, and pause/resume playback. Behavior Boolean true false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
loop If this attribute is true, the videoplayer will, upon reaching the end of the video, automatically seek back to the start. Behavior Boolean false false false false false false true
muted Mute the audio of the video. Behavior Boolean false false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
poster Specifies an image to be shown while the video is downloading, or until the user hits the play button Appearance ImagePath false false false false false true
preload Defines if and how the video contents should start loading as the page loads. Possible values: 'none', 'auto', 'metadata' Behavior brease.enum.VideoPlayerPreload none false false false false false true
src Path to a video file (e.g. Media/Video.mp4). There are generally 3 supported video formats: MP4, WebM and Ogg. Notice: iOS devices can only play MP4 files with H.264 video encoding. A text key can be used. Data VideoPath true false false true false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
visible change visibility Behavior Boolean true true false false false false true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 480 false false false true true
width outer width of widget Size 640 false false false true true

Styleable Properties

name type description defaultValue
backColor Color

Sets the background color

 transparent
backGroundGradient Gradient

Background as a gradient
borderWidth PixelValCollection

Sets the width of the border

 2px
borderColor ColorCollection

Sets the border color

 #FFF
borderStyle BorderStyle

Style of the Border of the widget

 none
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners

 0px
shadow Shadow

Shadow of the Widget

 none
margin Margin

Margin of the Widget

 0px
opacity Opacity

Opacity of the widget

 1
rotation Rotation

Rotation of widget.

 0deg

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

VideoEnded Fired when the video has ended.
VideoPaused Fired when the video has been paused.
VideoStarted Fired when the video has been started.
VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
SetEnable Sets the state of property «enable»
  • value: Boolean

SetSrc Sets source location of the video file, e.g. "/Media/help_video.mp4"
  • value: String

    Path of the video file, e.g. "/Media/help_video.mp4"

SetStyle
  • value: StyleReference

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip
StartVideo Starts the video.
StopVideo Stops the video.